Classifying and Recommending Knowledge in Reference Documentation to Improve Api Usability

نویسنده

  • Yam Bahadur Chhetri
چکیده

Reference documentation is an important source of information on API usage. Programmers, however, can easily overlook reference information because of its tedious nature, and because the information they seek can be buried among irrelevant or boiler-plate text. We propose to detect and recommend fragments of API documentation relevant and important to a task. We categorize pieces of information in API documentation based on the type of knowledge they contain. From the pieces that contain knowledge worthy of recommendation, we extract the composition and the pattern of words, and use the patterns to automatically find new pieces that contain similar knowledge. In an evaluation study, with a training set of manually-classified reference documentation of about 1 000 API elements, we could issue recommendations with about, on average, 90% precision and 69% recall.

برای دانلود رایگان متن کامل این مقاله و بیش از 32 میلیون مقاله دیگر ابتدا ثبت نام کنید

ثبت نام

اگر عضو سایت هستید لطفا وارد حساب کاربری خود شوید

منابع مشابه

OntoCat: Automatically categorizing knowledge in API Documentation

Most application development happens in the context of complex APIs; reference documentation for APIs has grown tremendously in variety, complexity, and volume, and can be difficult to navigate. There is a growing need to develop well-organized ways to access the knowledge latent in the documentation; several research efforts deal with the organization (ontology) of APIrelated knowledge. Extens...

متن کامل

Usability of Mobile Website of the Libraries of Top Medical Sciences Universities in Iran

Background and Aim: One of the essential methods of evaluating academic libraries’ mobile websites is the usability analysis method; websites’ usability means their ease and simplicity of use. This study aims to evaluate the usability of the mobile website of the libraries of top medical universities in Iran. This study aims to evaluate the usability of mobile websites of the libraries of top I...

متن کامل

An Empirical Study on Evolution of API Documentation

With the evolution of an API library, its documentation also evolves. The evolution of API documentation is common knowledge for programmers and library developers, but not in a quantitative form. Without such quantitative knowledge, programmers may neglect important revisions of API documentation, and library developers may not effectively improve API documentation based on its revision histor...

متن کامل

Use - Oriented Documentation in Software Development

Software documentation is an important tool in modern component-based programming. Building software applications requires detailed knowledge about a vast number of components and the structures they form. This knowledge is often acquired by reading reference documentation of application-programming interfaces (APIs). Thus, the design of the API reference documentation and its reading support a...

متن کامل

Documentation Status in Shahid Chamran University (SCU) Registrars from Their Employees’ Viewpoints

Abstract: The purpose of the present survey is to study the status of knowledge documentation in SCU registrars from the registrars’ employees’ viewpoints in SCU. The research is a survey of a descriptive-analytical type. The questionnaires were distributed among 110 registrars’ employees in SCU. To analyze the data, some descriptive and inferential statistical tests were employed. Findings ind...

متن کامل

ذخیره در منابع من


  با ذخیره ی این منبع در منابع من، دسترسی به آن را برای استفاده های بعدی آسان تر کنید

عنوان ژورنال:

دوره   شماره 

صفحات  -

تاریخ انتشار 2012